Copyright: Copyright ©1998 Zugg Software


Contents

#SETPROMPT

Tells the plugin how to process your MUD Prompt

#GAUGE

Defines a graphical gauge to display variables


GAUGE

Syntax: #GAUGE num name curval maxval [redval]
Example

Defines a graphical gauge used to plot two variables.  A horizontal "progress bar" is displayed, with the current value given by the "curval" expression and the maximum value given by the "maxval" expression.  The "redval" expression is optional and specifies the threshold below which the bar is red, above which the bar is blue.

Name is the name of the gauge printed to the left of the bar.  Num is the gauge number to modify.  You can have up to ten gauges, numbered 1 through 10.

You can also use the GAUGE command to turn on and off the gauge window or individual gauges using the "on" and "off" strings.  See the examples for details.


GAUGE Example

#GAUGE 1 Hp @hp @maxhp (@maxhp/10)

Defines a gauge for the hp variables captured by the prompt.  The current value of @hp is displayed, with the maximum value of the progress bar equal to @maxhp.  The (@maxhp/10) expression makes the progress bar red when @hp falls below @maxhp/10.

#GAUGE 1 off

Turns off gauge one.

#GAUGE 1 on

Turns on gauge on using the previously defined settings

#GAUGE off

Turns off the gauge window

#GAUGE on

Turns on the gauge window


SETPROMPT

Syntax: #SETPROMPT PromptStr [variable-names]
Example

This command defines the syntax for zMUD to parse your MUD prompt.  The PromptStr is the unique characters that your prompt starts with (usually a "[" or "<") and you then list the names of the variables that you want to assign each numeric value in your prompt to.


SETPROMPT Example

Here are some SETPROMPT examples for different MUD Prompts:

<100/150hp 50/200mana 100/100mv>
#SETPROMPT "<" hp maxhp mana maxmana mv maxmv

Assigns each numeric value in the prompt to the given variable.  Note that you do not use the @ character, just the variable name.

[100h 200m]
#SETPROMPT "[" hp mana

In order to use the gauges you'll have to set up variables for maxhp and maxmana yourself since the values are not shown in the prompt